Skip to content

feat(report): improve human-readable interpretation wording - #6

Merged
MMoney1988 merged 2 commits into
mainfrom
feat/report-readable-interpretation
May 11, 2026
Merged

feat(report): improve human-readable interpretation wording#6
MMoney1988 merged 2 commits into
mainfrom
feat/report-readable-interpretation

Conversation

@MMoney1988

Copy link
Copy Markdown
Owner

Summary

  • Improve the generated report Interpretation copy so REVIEW explains warnings in plainer language.
  • Regenerate the included page 006 and page 012 example reports and update the README excerpt.

Why

  • The report should help a reader understand why REVIEW was selected before external human-readability review.

What

  • Preserve checks, counts, IDs, statuses, details sections, section order, CLI behavior, decisions, and exit codes.
  • Make the Interpretation wording clearer for content/noise, text-usefulness, and ambiguous image findings.
  • Keep technical evidence in Noise / Layout Signals and check detail sections.

Tests

  • .venv/bin/python -m pytest -p no:cacheprovider tests
  • .venv/bin/python -m ruff check src tests
  • .venv/bin/python -m pdf_quality_report.report --help
  • git diff --check
  • rg -n "Users/|private/tmp|Development/" README.md docs examples

Risks

  • Low: wording changes may still need refinement after external readability feedback.

Rollback

  • Revert this PR to restore the previous Interpretation wording and generated examples.

@MMoney1988
MMoney1988 merged commit 5359d21 into main May 11, 2026
1 check passed
@MMoney1988
MMoney1988 deleted the feat/report-readable-interpretation branch May 11, 2026 10:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant